<!DOCTYPE html>
<html>
<head>
	<meta charset="utf-8">

	<title>NBMWebRTCPeer Class Reference</title>

	<link rel="stylesheet" href="../css/style.css">
	<meta name="viewport" content="initial-scale=1, maximum-scale=1.4">
	<meta name="generator" content="appledoc 2.2.1 (build 1334)">
</head>
<body class="appledoc">
	<header>
		<div class="container" class="hide-in-xcode">
			
			<h1 id="library-title">
				<a href="../index.html">KurentoToolbox </a>
			</h1>

			<p id="developer-home">
				<a href="../index.html">Nubomedia TI</a>
			</p>
			
		</div>
	</header>

	<aside>
		<div class="container">
			<nav>
				<ul id="header-buttons" role="toolbar">
					<li><a href="../index.html">Index</a></li>
<li><a href="../hierarchy.html">Hierarchy</a></li>

					<li id="on-this-page" role="navigation">
						<label>
							On This Page

							<div class="chevron">
								<div class="chevy chevron-left"></div>
								<div class="chevy chevron-right"></div>
							</div>

							<select id="jump-to">
	<option value="top">Jump To&#133;</option>
	
	<option value="overview">Overview</option>
	

	
	
	<option value="tasks">Tasks</option>
	
	

	
	
	<optgroup label="Properties">
		
		<option value="//api/name/cameraPosition">cameraPosition</option>
		
		<option value="//api/name/delegate">delegate</option>
		
		<option value="//api/name/localStream">localStream</option>
		
		<option value="//api/name/mediaConfiguration">mediaConfiguration</option>
		
	</optgroup>
	

	

	
	<optgroup label="Instance Methods">
		
		<option value="//api/name/activeConnections">- activeConnections</option>
		
		<option value="//api/name/addICECandidate:connectionId:">- addICECandidate:connectionId:</option>
		
		<option value="//api/name/audioAuthorized">- audioAuthorized</option>
		
		<option value="//api/name/closeConnectionWithConnectionId:">- closeConnectionWithConnectionId:</option>
		
		<option value="//api/name/connectionWithConnectionId:">- connectionWithConnectionId:</option>
		
		<option value="//api/name/enableAudio:">- enableAudio:</option>
		
		<option value="//api/name/enableVideo:">- enableVideo:</option>
		
		<option value="//api/name/generateOffer:">- generateOffer:</option>
		
		<option value="//api/name/generateOffer:completion:">- generateOffer:completion:</option>
		
		<option value="//api/name/hasCameraPositionAvailable:">- hasCameraPositionAvailable:</option>
		
		<option value="//api/name/initWithDelegate:configuration:">- initWithDelegate:configuration:</option>
		
		<option value="//api/name/isAudioEnabled">- isAudioEnabled</option>
		
		<option value="//api/name/isVideoEnabled">- isVideoEnabled</option>
		
		<option value="//api/name/processAnswer:connectionId:">- processAnswer:connectionId:</option>
		
		<option value="//api/name/processOffer:connectionId:">- processOffer:connectionId:</option>
		
		<option value="//api/name/selectCameraPosition:">- selectCameraPosition:</option>
		
		<option value="//api/name/startLocalMedia">- startLocalMedia</option>
		
		<option value="//api/name/stopLocalMedia">- stopLocalMedia</option>
		
		<option value="//api/name/videoAuthorized">- videoAuthorized</option>
		
	</optgroup>
	
	
</select>
						</label>
					</li>
				</ul>
			</nav>
		</div>
	</aside>

	<article>
		<div id="overview_contents" class="container">
			<div id="content">
				<main role="main">
					<h1 class="title">NBMWebRTCPeer Class Reference</h1>

					
					<div class="section section-specification"><table cellspacing="0"><tbody>
						<tr>
	<th>Inherits from</th>
	<td>NSObject</td>
</tr><tr>
	<th>Declared in</th>
	<td>NBMWebRTCPeer.h</td>
</tr>
						</tbody></table></div>
					

                    
					
					

					
					
					<div class="section section-tasks">
						<a title="Tasks" name="tasks"></a>
						

						
						

						<div class="task-list">
							<div class="section-method">
	<a name="//api/name/mediaConfiguration" title="mediaConfiguration"></a>
	<h3 class="method-title"><code><a href="#//api/name/mediaConfiguration">&nbsp;&nbsp;mediaConfiguration</a></code>
</h3>

	<div class="method-info">
		<div class="pointy-thing"></div>

		<div class="method-info-container">
			
			
			<div class="method-subsection brief-description">
				<p>The media configuration object.</p>
			</div>
			
		    

			<div class="method-subsection method-declaration"><code>@property (nonatomic, strong, readonly) NBMMediaConfiguration *mediaConfiguration</code></div>

		    
			

			

			

			

			

			

			
			<div class="method-subsection declared-in-section">
				<h4 class="method-subtitle">Declared In</h4>
				<p><code class="declared-in-ref">NBMWebRTCPeer.h</code></p>
			</div>
			
			
		</div>
	</div>
</div><div class="section-method">
	<a name="//api/name/localStream" title="localStream"></a>
	<h3 class="method-title"><code><a href="#//api/name/localStream">&nbsp;&nbsp;localStream</a></code>
</h3>

	<div class="method-info">
		<div class="pointy-thing"></div>

		<div class="method-info-container">
			
			
			<div class="method-subsection brief-description">
				<p>The local stream.</p>
			</div>
			
		    

			<div class="method-subsection method-declaration"><code>@property (nonatomic, strong, readonly) RTCMediaStream *localStream</code></div>

		    
			

			

			

			

			

			

			
			<div class="method-subsection declared-in-section">
				<h4 class="method-subtitle">Declared In</h4>
				<p><code class="declared-in-ref">NBMWebRTCPeer.h</code></p>
			</div>
			
			
		</div>
	</div>
</div><div class="section-method">
	<a name="//api/name/cameraPosition" title="cameraPosition"></a>
	<h3 class="method-title"><code><a href="#//api/name/cameraPosition">&nbsp;&nbsp;cameraPosition</a></code>
</h3>

	<div class="method-info">
		<div class="pointy-thing"></div>

		<div class="method-info-container">
			

			<div class="method-subsection method-declaration"><code>@property (nonatomic, assign, readonly) NBMCameraPosition cameraPosition</code></div>

		    
		</div>
	</div>
</div><div class="section-method">
	<a name="//api/name/delegate" title="delegate"></a>
	<h3 class="method-title"><code><a href="#//api/name/delegate">&nbsp;&nbsp;delegate</a></code>
</h3>

	<div class="method-info">
		<div class="pointy-thing"></div>

		<div class="method-info-container">
			
			
			<div class="method-subsection brief-description">
				<p>The delegate object for the peer.</p>
			</div>
			
		    

			<div class="method-subsection method-declaration"><code>@property (nonatomic, weak, readonly) id&lt;NBMWebRTCPeerDelegate&gt; delegate</code></div>

		    
			

			

			

			

			

			

			
			<div class="method-subsection declared-in-section">
				<h4 class="method-subtitle">Declared In</h4>
				<p><code class="declared-in-ref">NBMWebRTCPeer.h</code></p>
			</div>
			
			
		</div>
	</div>
</div><div class="section-method">
	<a name="//api/name/initWithDelegate:configuration:" title="initWithDelegate:configuration:"></a>
	<h3 class="method-title"><code><a href="#//api/name/initWithDelegate:configuration:">&ndash;&nbsp;initWithDelegate:configuration:</a></code>
</h3>

	<div class="method-info">
		<div class="pointy-thing"></div>

		<div class="method-info-container">
			
			
			<div class="method-subsection brief-description">
				<p>Initializes a new Web RTC peer manager.</p>
			</div>
			
		    

			<div class="method-subsection method-declaration"><code>- (instancetype)initWithDelegate:(id&lt;NBMWebRTCPeerDelegate&gt;)<em>delegate</em> configuration:(NBMMediaConfiguration *)<em>configuration</em></code></div>

		    
			
			<div class="method-subsection arguments-section parameters">
				<h4 class="method-subtitle parameter-title">Parameters</h4>
				<table class="argument-def parameter-def">
				
					<tr>
						<th scope="row" class="argument-name"><code>delegate</code></th>
						<td><p>The delegate object for the peer manager.</p></td>
					</tr>
				
					<tr>
						<th scope="row" class="argument-name"><code>configuration</code></th>
						<td><p>A media configuration object.</p></td>
					</tr>
				
				</table>
			</div>
			

			
			<div class="method-subsection return">
				<h4 class="method-subtitle parameter-title">Return Value</h4>
				<p>An initialized Web RTC peer manager.</p>
			</div>
			

			

			

			

			

			
			<div class="method-subsection declared-in-section">
				<h4 class="method-subtitle">Declared In</h4>
				<p><code class="declared-in-ref">NBMWebRTCPeer.h</code></p>
			</div>
			
			
		</div>
	</div>
</div><div class="section-method">
	<a name="//api/name/generateOffer:" title="generateOffer:"></a>
	<h3 class="method-title"><code><a href="#//api/name/generateOffer:">&ndash;&nbsp;generateOffer:</a></code>
</h3>

	<div class="method-info">
		<div class="pointy-thing"></div>

		<div class="method-info-container">
			
			
			<div class="method-subsection brief-description">
				<p>Create a new offer for connection with specified identifier.</p>
			</div>
			
		    

			<div class="method-subsection method-declaration"><code>- (void)generateOffer:(NSString *)<em>connectionId</em></code></div>

		    
			
			<div class="method-subsection arguments-section parameters">
				<h4 class="method-subtitle parameter-title">Parameters</h4>
				<table class="argument-def parameter-def">
				
					<tr>
						<th scope="row" class="argument-name"><code>connectionId</code></th>
						<td><p>The connection identifier.</p></td>
					</tr>
				
				</table>
			</div>
			

			

			

			

			

			

			
			<div class="method-subsection declared-in-section">
				<h4 class="method-subtitle">Declared In</h4>
				<p><code class="declared-in-ref">NBMWebRTCPeer.h</code></p>
			</div>
			
			
		</div>
	</div>
</div><div class="section-method">
	<a name="//api/name/generateOffer:completion:" title="generateOffer:completion:"></a>
	<h3 class="method-title"><code><a href="#//api/name/generateOffer:completion:">&ndash;&nbsp;generateOffer:completion:</a></code>
</h3>

	<div class="method-info">
		<div class="pointy-thing"></div>

		<div class="method-info-container">
			

			<div class="method-subsection method-declaration"><code>- (void)generateOffer:(NSString *)<em>connectionId</em> completion:(void ( ^ ) ( NSString *sdpOffer , NBMPeerConnection *connection ))<em>block</em></code></div>

		    
		</div>
	</div>
</div><div class="section-method">
	<a name="//api/name/processOffer:connectionId:" title="processOffer:connectionId:"></a>
	<h3 class="method-title"><code><a href="#//api/name/processOffer:connectionId:">&ndash;&nbsp;processOffer:connectionId:</a></code>
</h3>

	<div class="method-info">
		<div class="pointy-thing"></div>

		<div class="method-info-container">
			
			
			<div class="method-subsection brief-description">
				<p>Process a remote offer for connection with specified identifier.</p>
			</div>
			
		    

			<div class="method-subsection method-declaration"><code>- (void)processOffer:(NSString *)<em>sdpOffer</em> connectionId:(NSString *)<em>connectionId</em></code></div>

		    
			
			<div class="method-subsection arguments-section parameters">
				<h4 class="method-subtitle parameter-title">Parameters</h4>
				<table class="argument-def parameter-def">
				
					<tr>
						<th scope="row" class="argument-name"><code>sdpOffer</code></th>
						<td><p>The SDP offer.</p></td>
					</tr>
				
					<tr>
						<th scope="row" class="argument-name"><code>connectionId</code></th>
						<td><p>The connection identifier.</p></td>
					</tr>
				
				</table>
			</div>
			

			

			

			

			

			

			
			<div class="method-subsection declared-in-section">
				<h4 class="method-subtitle">Declared In</h4>
				<p><code class="declared-in-ref">NBMWebRTCPeer.h</code></p>
			</div>
			
			
		</div>
	</div>
</div><div class="section-method">
	<a name="//api/name/processAnswer:connectionId:" title="processAnswer:connectionId:"></a>
	<h3 class="method-title"><code><a href="#//api/name/processAnswer:connectionId:">&ndash;&nbsp;processAnswer:connectionId:</a></code>
</h3>

	<div class="method-info">
		<div class="pointy-thing"></div>

		<div class="method-info-container">
			
			
			<div class="method-subsection brief-description">
				<p>Process a remote answer for connection with specified identifier.</p>
			</div>
			
		    

			<div class="method-subsection method-declaration"><code>- (void)processAnswer:(NSString *)<em>sdpAnswer</em> connectionId:(NSString *)<em>connectionId</em></code></div>

		    
			
			<div class="method-subsection arguments-section parameters">
				<h4 class="method-subtitle parameter-title">Parameters</h4>
				<table class="argument-def parameter-def">
				
					<tr>
						<th scope="row" class="argument-name"><code>sdpAnswer</code></th>
						<td><p>The SDP answer.</p></td>
					</tr>
				
					<tr>
						<th scope="row" class="argument-name"><code>connectionId</code></th>
						<td><p>The connection identifier.</p></td>
					</tr>
				
				</table>
			</div>
			

			

			

			

			

			

			
			<div class="method-subsection declared-in-section">
				<h4 class="method-subtitle">Declared In</h4>
				<p><code class="declared-in-ref">NBMWebRTCPeer.h</code></p>
			</div>
			
			
		</div>
	</div>
</div><div class="section-method">
	<a name="//api/name/addICECandidate:connectionId:" title="addICECandidate:connectionId:"></a>
	<h3 class="method-title"><code><a href="#//api/name/addICECandidate:connectionId:">&ndash;&nbsp;addICECandidate:connectionId:</a></code>
</h3>

	<div class="method-info">
		<div class="pointy-thing"></div>

		<div class="method-info-container">
			
			
			<div class="method-subsection brief-description">
				<p>Provides a remote candidate to ICE agent for connection with specified identifier.</p>
			</div>
			
		    

			<div class="method-subsection method-declaration"><code>- (void)addICECandidate:(RTCICECandidate *)<em>candidate</em> connectionId:(NSString *)<em>connectionId</em></code></div>

		    
			
			<div class="method-subsection arguments-section parameters">
				<h4 class="method-subtitle parameter-title">Parameters</h4>
				<table class="argument-def parameter-def">
				
					<tr>
						<th scope="row" class="argument-name"><code>candidate</code></th>
						<td><p>A RTCICECandidate instance.</p></td>
					</tr>
				
					<tr>
						<th scope="row" class="argument-name"><code>connectionId</code></th>
						<td><p>The connection identifier.</p></td>
					</tr>
				
				</table>
			</div>
			

			

			

			

			

			

			
			<div class="method-subsection declared-in-section">
				<h4 class="method-subtitle">Declared In</h4>
				<p><code class="declared-in-ref">NBMWebRTCPeer.h</code></p>
			</div>
			
			
		</div>
	</div>
</div><div class="section-method">
	<a name="//api/name/connectionWithConnectionId:" title="connectionWithConnectionId:"></a>
	<h3 class="method-title"><code><a href="#//api/name/connectionWithConnectionId:">&ndash;&nbsp;connectionWithConnectionId:</a></code>
</h3>

	<div class="method-info">
		<div class="pointy-thing"></div>

		<div class="method-info-container">
			
			
			<div class="method-subsection brief-description">
				<p>Retrives a NBMPeerConnection instance with specified identifier.</p>
			</div>
			
		    

			<div class="method-subsection method-declaration"><code>- (NBMPeerConnection *)connectionWithConnectionId:(NSString *)<em>connectionId</em></code></div>

		    
			
			<div class="method-subsection arguments-section parameters">
				<h4 class="method-subtitle parameter-title">Parameters</h4>
				<table class="argument-def parameter-def">
				
					<tr>
						<th scope="row" class="argument-name"><code>connectionId</code></th>
						<td><p>The connection identifier.</p></td>
					</tr>
				
				</table>
			</div>
			

			
			<div class="method-subsection return">
				<h4 class="method-subtitle parameter-title">Return Value</h4>
				<p>A NBMPeerConnection instance, <code>nil</code> if no connection was found.</p>
			</div>
			

			

			

			

			

			
			<div class="method-subsection declared-in-section">
				<h4 class="method-subtitle">Declared In</h4>
				<p><code class="declared-in-ref">NBMWebRTCPeer.h</code></p>
			</div>
			
			
		</div>
	</div>
</div><div class="section-method">
	<a name="//api/name/closeConnectionWithConnectionId:" title="closeConnectionWithConnectionId:"></a>
	<h3 class="method-title"><code><a href="#//api/name/closeConnectionWithConnectionId:">&ndash;&nbsp;closeConnectionWithConnectionId:</a></code>
</h3>

	<div class="method-info">
		<div class="pointy-thing"></div>

		<div class="method-info-container">
			
			
			<div class="method-subsection brief-description">
				<p>Terminates all media and closes the transport of NBMPeerConnection with specified identifier.</p>
			</div>
			
		    

			<div class="method-subsection method-declaration"><code>- (void)closeConnectionWithConnectionId:(NSString *)<em>connectionId</em></code></div>

		    
			
			<div class="method-subsection arguments-section parameters">
				<h4 class="method-subtitle parameter-title">Parameters</h4>
				<table class="argument-def parameter-def">
				
					<tr>
						<th scope="row" class="argument-name"><code>connectionId</code></th>
						<td><p>The connection identifier.</p></td>
					</tr>
				
				</table>
			</div>
			

			

			

			

			

			

			
			<div class="method-subsection declared-in-section">
				<h4 class="method-subtitle">Declared In</h4>
				<p><code class="declared-in-ref">NBMWebRTCPeer.h</code></p>
			</div>
			
			
		</div>
	</div>
</div><div class="section-method">
	<a name="//api/name/startLocalMedia" title="startLocalMedia"></a>
	<h3 class="method-title"><code><a href="#//api/name/startLocalMedia">&ndash;&nbsp;startLocalMedia</a></code>
</h3>

	<div class="method-info">
		<div class="pointy-thing"></div>

		<div class="method-info-container">
			

			<div class="method-subsection method-declaration"><code>- (BOOL)startLocalMedia</code></div>

		    
		</div>
	</div>
</div><div class="section-method">
	<a name="//api/name/stopLocalMedia" title="stopLocalMedia"></a>
	<h3 class="method-title"><code><a href="#//api/name/stopLocalMedia">&ndash;&nbsp;stopLocalMedia</a></code>
</h3>

	<div class="method-info">
		<div class="pointy-thing"></div>

		<div class="method-info-container">
			
			
			<div class="method-subsection brief-description">
				<p>Terminates all media of active connections, removing the local stream.</p>
			</div>
			
		    

			<div class="method-subsection method-declaration"><code>- (void)stopLocalMedia</code></div>

		    
			

			

			

			

			

			

			
			<div class="method-subsection declared-in-section">
				<h4 class="method-subtitle">Declared In</h4>
				<p><code class="declared-in-ref">NBMWebRTCPeer.h</code></p>
			</div>
			
			
		</div>
	</div>
</div><div class="section-method">
	<a name="//api/name/activeConnections" title="activeConnections"></a>
	<h3 class="method-title"><code><a href="#//api/name/activeConnections">&ndash;&nbsp;activeConnections</a></code>
</h3>

	<div class="method-info">
		<div class="pointy-thing"></div>

		<div class="method-info-container">
			

			<div class="method-subsection method-declaration"><code>- (NSArray *)activeConnections</code></div>

		    
		</div>
	</div>
</div><div class="section-method">
	<a name="//api/name/selectCameraPosition:" title="selectCameraPosition:"></a>
	<h3 class="method-title"><code><a href="#//api/name/selectCameraPosition:">&ndash;&nbsp;selectCameraPosition:</a></code>
</h3>

	<div class="method-info">
		<div class="pointy-thing"></div>

		<div class="method-info-container">
			

			<div class="method-subsection method-declaration"><code>- (void)selectCameraPosition:(NBMCameraPosition)<em>cameraPosition</em></code></div>

		    
		</div>
	</div>
</div><div class="section-method">
	<a name="//api/name/hasCameraPositionAvailable:" title="hasCameraPositionAvailable:"></a>
	<h3 class="method-title"><code><a href="#//api/name/hasCameraPositionAvailable:">&ndash;&nbsp;hasCameraPositionAvailable:</a></code>
</h3>

	<div class="method-info">
		<div class="pointy-thing"></div>

		<div class="method-info-container">
			

			<div class="method-subsection method-declaration"><code>- (BOOL)hasCameraPositionAvailable:(NBMCameraPosition)<em>cameraPosition</em></code></div>

		    
		</div>
	</div>
</div><div class="section-method">
	<a name="//api/name/isVideoEnabled" title="isVideoEnabled"></a>
	<h3 class="method-title"><code><a href="#//api/name/isVideoEnabled">&ndash;&nbsp;isVideoEnabled</a></code>
</h3>

	<div class="method-info">
		<div class="pointy-thing"></div>

		<div class="method-info-container">
			

			<div class="method-subsection method-declaration"><code>- (BOOL)isVideoEnabled</code></div>

		    
		</div>
	</div>
</div><div class="section-method">
	<a name="//api/name/enableVideo:" title="enableVideo:"></a>
	<h3 class="method-title"><code><a href="#//api/name/enableVideo:">&ndash;&nbsp;enableVideo:</a></code>
</h3>

	<div class="method-info">
		<div class="pointy-thing"></div>

		<div class="method-info-container">
			

			<div class="method-subsection method-declaration"><code>- (void)enableVideo:(BOOL)<em>enable</em></code></div>

		    
		</div>
	</div>
</div><div class="section-method">
	<a name="//api/name/isAudioEnabled" title="isAudioEnabled"></a>
	<h3 class="method-title"><code><a href="#//api/name/isAudioEnabled">&ndash;&nbsp;isAudioEnabled</a></code>
</h3>

	<div class="method-info">
		<div class="pointy-thing"></div>

		<div class="method-info-container">
			

			<div class="method-subsection method-declaration"><code>- (BOOL)isAudioEnabled</code></div>

		    
		</div>
	</div>
</div><div class="section-method">
	<a name="//api/name/enableAudio:" title="enableAudio:"></a>
	<h3 class="method-title"><code><a href="#//api/name/enableAudio:">&ndash;&nbsp;enableAudio:</a></code>
</h3>

	<div class="method-info">
		<div class="pointy-thing"></div>

		<div class="method-info-container">
			

			<div class="method-subsection method-declaration"><code>- (void)enableAudio:(BOOL)<em>enable</em></code></div>

		    
		</div>
	</div>
</div><div class="section-method">
	<a name="//api/name/videoAuthorized" title="videoAuthorized"></a>
	<h3 class="method-title"><code><a href="#//api/name/videoAuthorized">&ndash;&nbsp;videoAuthorized</a></code>
</h3>

	<div class="method-info">
		<div class="pointy-thing"></div>

		<div class="method-info-container">
			

			<div class="method-subsection method-declaration"><code>- (BOOL)videoAuthorized</code></div>

		    
		</div>
	</div>
</div><div class="section-method">
	<a name="//api/name/audioAuthorized" title="audioAuthorized"></a>
	<h3 class="method-title"><code><a href="#//api/name/audioAuthorized">&ndash;&nbsp;audioAuthorized</a></code>
</h3>

	<div class="method-info">
		<div class="pointy-thing"></div>

		<div class="method-info-container">
			

			<div class="method-subsection method-declaration"><code>- (BOOL)audioAuthorized</code></div>

		    
		</div>
	</div>
</div>
						</div>
						
					</div>
					
					

                    
                    
          
				</main>

				<footer>
					<div class="footer-copyright">
						
						<p class="copyright">Copyright &copy; 2016 Nubomedia TI. All rights reserved. Updated: 2016-02-12</p>
						
						
						<p class="generator">Generated by <a href="http://appledoc.gentlebytes.com">appledoc 2.2.1 (build 1334)</a>.</p>
						
					</div>
				</footer>
			</div>
		</div>
	</article>

	<script src="../js/script.js"></script>
</body>
</html>